home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr46 / basxrf12.zip / BASICXR.DOC < prev    next >
Text File  |  1993-05-23  |  10KB  |  269 lines
  1.                      BasicXR Cross Reference Utility            v 1.2
  2.                      Copyright 1991-1993  JNGoodale
  3.                         _______
  4.                    ____|__     |                (R)
  5.                 --|       |    |-------------------
  6.                   |   ____|__  |  Association of
  7.                   |  |       |_|  Shareware
  8.                   |__|   o   |    Professionals
  9.                 -----|   |   |---------------------
  10.                      |___|___|    MEMBER
  11.  
  12.  
  13.     Files included in BASXRF.EXE:
  14.  
  15.                     BASICXR.COM     Executable program
  16.                     BASICXR.DOC     This file
  17.                     BASICXRW.XXT    Starter file for Custom Res Words
  18.                     BASICXRW.PDS    Microsoft PDS Custom Res Words
  19.                     README.TXT      Brief documentation
  20.                     REGISTER.DOC    Registration form (UnRegistered Version
  21.                                       Only)
  22.     -------------------------------------------------------------------------
  23.     This document covers the following:
  24.  
  25.             1.  General description
  26.             2.  Start-up
  27.             3.  Printer control codes
  28.             4.  Printing to a file
  29.             5.  Forcing a page eject
  30.             6.  Creating a file of Reserved Words
  31.             7.  Requirements/Limitations
  32.             8.  Error messages
  33.             9.  Support
  34.            10.  Registration
  35.            11.  Shareware Concept/Ombudsman information
  36.  
  37.     ====================================================================
  38.  
  39.     1.  GENERAL DESCRIPTION
  40.  
  41.         This program will cross reference a program written in Basic
  42.         and saved as an ASCII file.  It will create any combination
  43.         of the following three options:
  44.  
  45.                     Formatted program listing
  46.                     User label/line number and variable cross reference
  47.                     Reserved word cross reference
  48.  
  49.         BASICXR.COM is the un-registered version and displays a
  50.         registration reminder each time it is run.
  51.  
  52.         The registered version functions identically, but the registration 
  53.         reminder is removed and it is about  5K shorter.  You receive this 
  54.         version when you register.
  55.  
  56.                                Page 1 of 5
  57.  
  58.  
  59.  
  60.     2.  START-UP
  61.  
  62.         To execute the program, simply enter BASICXR followed optionally 
  63.         by "/ switches", as described below:
  64.  
  65.                 BASICXR/M  will force the program to monochrome display.
  66.  
  67.                 BASICXR/E  will send printer control codes for Epson
  68.                            compatible printers.  See # 3 below.
  69.  
  70.                 BASICXR/D  will send printer control codes for DeskJet
  71.                            compatible printers.  See # 3 below.
  72.  
  73.         The "/M" switch can be used in conjunction with either of the
  74.         printer switches.  Order and case are not important.
  75.  
  76.  
  77.     3.  PRINTER CONTROL CODES
  78.  
  79.         If you elect to print compressed pitch for either an Epson or
  80.         DeskJet compatible printer, start the program with the
  81.         appropriate switch (/E or /D).  The program will send the
  82.         following printer control codes to your printer (or to the
  83.         output file, if you elect to output to a file for later printing):
  84.  
  85.                                 /D (DeskJet)            /E (Epson)
  86.  
  87.                 Reset           CHR$(27);"E"            CHR$(27);"@"
  88.                 Compressed      CHR$(27);"(s16.67H"     CHR$(15)
  89.  
  90.                 Line width      110 characters          120 characters
  91.                 Lines/page      54                      54
  92.  
  93.         In both cases the program resets the printer at the end.
  94.  
  95.         *  If you do not execute the program with one of the printer 
  96.            switches, no control codes are sent.  Line width is 80, 
  97.            lines/page 54.
  98.  
  99.     4.  PRINTING TO A FILE
  100.  
  101.         By entering "f" or "F" at the prompt you can direct the output
  102.         to a file for later printing.  The name of the file created will
  103.         be the same base name as your input source file with an extension
  104.         of ".XRF".  It will be written to the same path as the source.
  105.  
  106.  
  107.  
  108.                                   Page  2 of 5
  109.  
  110.  
  111.  
  112.  
  113.     5.  FORCING A PAGE EJECT
  114.  
  115.         If you would like to force a page eject in the program listing,
  116.         simply insert a line with two single quotes as the only text on
  117.         the line - '' - NOT a double quote (").
  118.  
  119.         The single quote is shorthand for REM, so the two single quotes
  120.         will not affect your program, but will trigger a page eject in
  121.         BasicXR.
  122.  
  123.     6.  CREATING A FILE OF RESERVED WORDS
  124.  
  125.         BasicXR has a built in table of Microsoft QuickBasic 4.5 reserved
  126.         words.  For another dialect of Basic you can create your own set
  127.         in a file that must be called "BASICXRW.TXT".  This is simply a
  128.         text file of the reserved words.  A starter (BASICXRW.XXT) is
  129.         supplied with this program which you can use to edit to create
  130.         your own list.  It must be renamed to "BASICXRW.TXT" for it to
  131.         take effect.
  132.  
  133.         If your programs are written in Microsoft QuickBasic 4.5 you do
  134.         not need this file.
  135.  
  136.         Maximum size of BASICXRW.TXT is 400 entries.
  137.         Maximum record length for each entry is 16.
  138.  
  139.     7.  REQUIREMENTS/LIMITATIONS
  140.  
  141.         Minimum requirements to run BasicXR are:
  142.  
  143.                 IBM compatible computer
  144.                 Monochrome or color monitor
  145.                 Printer (unless printing to a file)
  146.                 DOS 2.11 or higher
  147.                 256K
  148.  
  149.         Programs to be cross-referenced must be saved in ASCII and have
  150.         the extension ".BAS".
  151.  
  152.         The program assumes Microsoft Basic dialects.  I do not guarantee
  153.         any other versions of Basic, although it might work.
  154.  
  155.         It will work with either line numbers (as in GWBasic) or line
  156.         labels (as in QuickBasic), but not both within the same program
  157.         (which QuickBasic allows for, but BasicXR doesn't).
  158.  
  159.         Customized Reserved Word file - Maximum 400 entries, Maximum
  160.         record length 16.
  161.  
  162.                                   Page  3 of 5
  163.  
  164.  
  165.  
  166.         The size of the program it can handle is based on how much main
  167.         memory you have (up to 640K) and how many references there are.
  168.         If it runs out of room for the reference table, the program
  169.         notifies you, marks the listing where referencing will stop, and
  170.         continues the listing, if that option is turned on.
  171.  
  172.         The solution at this point would be to break the program into
  173.         several parts and then run each part thru BasicXR.
  174.  
  175.     8.  ERROR MESSAGES
  176.  
  177.         The following error messages may occur:
  178.  
  179.             Bad Path entered
  180.             No *.BAS files
  181.             No options entered.  Ending
  182.             This is not an ASCII (text) file.  Ending
  183.             Reached max of 400 Reserved Words .. ignoring excess
  184.             Label reference table exceeded
  185.  
  186.         Except where "Ending" is stated, you are given the option to
  187.         [ESC] to quit or [ENTER] to try again.
  188.  
  189.     9.  SUPPORT
  190.  
  191.         Registered owners will receive free support for three months
  192.         after registration by contacting me thru US mail, CompuServe or
  193.         phone at:
  194.  
  195.                 Jane N. Goodale
  196.                 7826 Littlejohn Court     
  197.                 Charlotte,  NC  28227
  198.  
  199.                 (704)-537-0329
  200.  
  201.                 CIS PPN 71116,302
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.                                   Page  4 of 5
  214.  
  215.  
  216.  
  217.     10. REGISTRATION
  218.  
  219.         Registration is available for $15.  You can fill out and print
  220.         the registration form within the program BASICXR.EXE or from
  221.         the order blank "REGISTER.DOC".
  222.  
  223.         If you distribute copies of this program, please assure that
  224.         all files and documentation are present.
  225.  
  226.     11. SHAREWARE CONCEPT/OMBUDSMAN INFORMATION
  227.  
  228.         Shareware distribution gives users a chance to try software
  229.         before buying it.  If you try a Shareware program and continue
  230.         using it, you are expected to register.
  231.  
  232.         Shareware is a distribution method, not a type of software.  You
  233.         should find software that suits your needs and pocketbook, whether
  234.         it's commercial or Shareware.  The Shareware system makes fitting
  235.         your needs easier, because you can try before you buy.  And because
  236.         the overhead is low, prices are low also.  Shareware has the
  237.         ultimate money-back guarantee -- if you don't use the product,
  238.         you don't pay for it!
  239.  
  240.  
  241.                Association Of Shareware Professionals Ombudsmen
  242.  
  243.         This program is produced by a member of the Association of
  244.         Shareware Professionals (ASP).  ASP wants to make sure that the
  245.         shareware principle works for you.  If you are unable to resolve a
  246.         shareware-related problem with an ASP member by contacting the
  247.         member directly, ASP may be able to help.  The ASP Ombudsman can
  248.         help you resolve a dispute or problem with an ASP member, but does
  249.         not provide technical support for members' products.  Please write
  250.         to the ASP Ombudsman at P.O. Box 5786, Bellevue, WA 98006 or send
  251.         a Compuserve message via easyplex to ASP Ombudsman 70007,3536
  252.  
  253.  
  254.                          .... End of BASICXR.DOC ....
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                                   Page  5 of 5
  269.